|
|
|
Overview
The Diagnostics Configuration window contains settings which configure diagnostic messaging for the OpenSpan Windows Container. Open the Diagnositics Configuration window by right-clicking in the Composite Application Editor and selecting Diagnostics Configuration from the context menu.
The window contains two tabs. The first tab, Diagnostic Settings, allows you to set the configurable properties for the available diagnostic publishers and Application Diagnostics. The second tab, Log Categories, enables you to set the level of diagnostic reporting for the FilePublisher option. 
Note: Certain options available in the Diagnostics Configuration window are not yet enabled for the OpenSpan Windows Container. Such options include: Application Diagnostic Settings
Field Name | Description | Mode | On or Off setting. The default is On. Set this to On to enable diagnostic logging for the OpenSpan Windows Container. This setting is related to the Mode settings for the individual publishers. If you set the Application Diagnostics Settings Mode to Off and set the Mode for an individual Publisher, for example FilePublisher, then the Application Diagnostics Mode will change to On. | HookDebug | On or Off setting. The default is On. If you change this setting, the application must be restarted for changes for this setting to take effect.This enables a listener for standard debug messages. This setting applies to OpenSpan development use only. | HookException | On or Off setting. The default is On. If set to “On” this will enable what is called “UnhandledExceptionHandlers” for the main application domain – this is the facility that will show the “Final Curtain” message in the event some error occurs that OpenSpan does not handle elsewhere in the OpenSpan code base – this also allows logging of the error to any available publisher. If this is disabled (“Off”) and such an error occurs, you would see a standard Microsoft pop-up window for an unhandled error, and no log would occur of the error. When set to On and an unhandled exception is encountered by OpenSpan, the exception information is written to the OpenSpan.Studio.exe.Exception text file. This file is located in the same folder as the IntegratorLog.txt file. | HookTrace | On or Off setting. The default is On. If set to “on” this will enable a diagnostic listener to the standard .NET “trace” messages, so any OpenSpan publishers will get messages routed to system.diagnostic.trace(…) and include them in their log. | Level | This sets a logging level using a Microsoft “TraceSwitch” object. This is a severity level with settings: off, then in increasing severity (verbose, info, warning, error) and sets the threshold for which a given message being logged has to meet or exceed the severity setting for this level in order to be recorded. This setting only applies to the start up messages in a diagnostic log such as when a publisher is initialized and the machine information is captured (e.g. machine name, version, etc.). All other messages use the severity set in the Log Categories. The levels are: Error - This setting only records error messages. . Warning -This setting records both warning and error messages. Info - This setting records informational messages along with warning and error messages. Verbose -This setting records all messages - error, warning, and informational. This is the default setting. Off -The setting turns off reporting of diagnostic messages. |
File Publisher The File Publisher creates an output file of diagnostic messages based on your settings in the Log Categories tab of the Diagnostics Configuration window. The log file captures the entire flow of the solution from start to finish. The name of the file used to store diagnostic information is IntegratorLog.txt by default. The default location of the file is the installation folder. Field Name | Description | Mode | On or Off setting. The default is Off. Set to On to write diagnostics information to an output file. | ExceptionMode | The File Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. If set to On, the publisher will record log messages from diagnostic events that originate from an exception source (HookException). Note that this setting is not related to the Hook Unhandled Exception setting. | TraceMode | The File Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. When set to On the publisher records log messages from diagnostic events that originate from a System.Diagnostic.Trace source. Note that this setting is not related to the Hook Trace setting. |
SuperTrace Publisher These settings determine if the OpenSpan Windows Container logs SuperTrace messages. In order to use SuperTrace, you must set the Mode for SuperTrace Publisher to On in the Diagnostics Configuration window. Additional SuperTrace configuration settings are in the Openspan.ini file. To view SuperTrace messages stored in the XML file, use the LogViewer application. Field Name | Description | Mode | On or Off setting. The default is Off. Set to On for OpenSpan Studio to generate SuperTrace messages. | ExceptionMode | The SuperTrace Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. If set to On, the publisher will record log messages from diagnostic events that originate from an exception source (HookException). Note that this setting is not related to the Hook Unhandled Exception setting. | TraceMode | The SuperTrace Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. When set to On the publisher records log messages from diagnostic events that originate from a System.Diagnostic.Trace source. Note that this setting is not related to the Hook Trace setting. |
EventLog Publisher Logs OpenSpan Windows Container events to the internal Windows event view.
Field Name | Description | Mode | On or Off setting. The default is Off. Set to On to enable event logging. | ExceptionMode | The EventLog Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. If set to On, the publisher will record log messages from diagnostic events that originate from an exception source (HookException). Note that this setting is not related to the Hook Unhandled Exception setting. | TraceMode | The EventLog Publisher Mode must be On for this setting to apply. On or Off setting. The default is On. When set to On the publisher records log messages from diagnostic events that originate from a System.Diagnostic.Trace source. Note that this setting is not related to the Hook Trace setting. |
Return to OpenSpan Table of Contents |